Create Prompt Partial

Overview

Prompts

Prompt Tools

Prompt Partials

Datasets

Evaluators

Log repositories

Folders

Workflows

Integrations

Alerts

Models

Test runs

Test run entries

Test run reports

Logging

Workspaces

Create Prompt Partial

curl --request POST \
  --url https://api.getmaxim.ai/v1/prompt-partials \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "folderId": "<string>"
}
'

import requests

url = "https://api.getmaxim.ai/v1/prompt-partials"

payload = {
    "workspaceId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "folderId": "<string>"
}
headers = {
    "x-maxim-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: '<string>',
    name: '<string>',
    description: '<string>',
    folderId: '<string>'
  })
};

fetch('https://api.getmaxim.ai/v1/prompt-partials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmaxim.ai/v1/prompt-partials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'folderId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-maxim-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmaxim.ai/v1/prompt-partials"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"folderId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-maxim-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getmaxim.ai/v1/prompt-partials")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"folderId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/prompt-partials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"folderId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "workspaceId": "<string>",
    "accountId": "<string>",
    "folderId": "<string>",
    "createdById": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

POST

prompt-partials

Create Prompt Partial

curl --request POST \
  --url https://api.getmaxim.ai/v1/prompt-partials \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "folderId": "<string>"
}
'

import requests

url = "https://api.getmaxim.ai/v1/prompt-partials"

payload = {
    "workspaceId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "folderId": "<string>"
}
headers = {
    "x-maxim-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: '<string>',
    name: '<string>',
    description: '<string>',
    folderId: '<string>'
  })
};

fetch('https://api.getmaxim.ai/v1/prompt-partials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmaxim.ai/v1/prompt-partials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'name' => '<string>',
    'description' => '<string>',
    'folderId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-maxim-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmaxim.ai/v1/prompt-partials"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"folderId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-maxim-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getmaxim.ai/v1/prompt-partials")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"folderId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/prompt-partials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"folderId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "workspaceId": "<string>",
    "accountId": "<string>",
    "folderId": "<string>",
    "createdById": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

Authorizations

x-maxim-api-key

string

header

required

API key for authentication

Body

application/json

workspaceId

string

required

Unique identifier for the workspace

name

string

required

Name of the prompt partial

description

string

Description of the prompt partial

folderId

string | null

Unique identifier for the folder

Response

Prompt partial created successfully

data

object

required

Show child attributes

⌘I